/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.ml.common

import org.apache.flink.ml.math.Vector

/** This class represents a vector with an associated label as it is required for many supervised
  * learning tasks.
  *
  * @param label Label of the data point
  * @param vector Data point
  */
case class LabeledVector(label: Double, vector: Vector) extends Serializable {

  override def equals(obj: Any): Boolean = {
    obj match {
      case labeledVector: LabeledVector =>
        vector.equals(labeledVector.vector) && label.equals(labeledVector.label)
      case _ => false
    }
  }

  override def toString: String = {
    s"LabeledVector($label, $vector)"
  }
}
